home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 1 / CU Amiga Magazine CD-ROM Special Edition (1995)(EMAP Images)(GB)[Issue 1995-11].iso / Magazine / Wired_World / AmIRC_056.LHA / MicroIRC.doc < prev    next >
Text File  |  1995-08-21  |  6KB  |  309 lines
  1.  
  2.  
  3. MicroIRC
  4. ********
  5.  
  6. Welcome to MicroIRC, the AmigaOS IRC client.
  7.  
  8. Copyright
  9. *********
  10.  
  11. Copyright
  12. =========
  13.  
  14. MicroIRC has been designed, developed and written by
  15.  
  16.      Oliver Wagner
  17.      Landsberge 5
  18.      45549 Sprockhövel
  19.      Germany
  20.      E-Mail: (o.wagner@lsd.wupper.de)
  21.  
  22. All Rights Reserved.
  23.  
  24. Thanksgiving
  25. ============
  26.  
  27. The author wishes to thank the following people for their help during
  28. MicroIRC development:
  29.  
  30. Yet to write, see About ;-)
  31. What is IRC, by the way?
  32. ************************
  33.  
  34. Introduction
  35. ============
  36.  
  37. Yet to write
  38.  
  39. Getting MicroIRC to run
  40. ***********************
  41.  
  42. Requirements
  43. ============
  44.  
  45. Yet to write
  46.  
  47. Connecting to a server
  48. **********************
  49.  
  50. Setup
  51. =====
  52.  
  53. Yet to write
  54.  
  55. Sending commands to other people
  56. ********************************
  57.  
  58. Introduction
  59. ============
  60.  
  61. Yet to write
  62.  
  63. Direct client connections
  64. *************************
  65.  
  66.  
  67.  
  68. Yet to write
  69.  
  70. Commands
  71. ********
  72.  
  73. Overview
  74. ========
  75.  
  76. MicroIRC has several builtin commands. Some of this commands are
  77. processed locally, whereas others are send to the IRC server.
  78.  
  79. Commands generally start with a / to differentiate them from normal
  80. text. If you want to use the / character at the start of normal text,
  81. use // instead.
  82.  
  83. Many commands require a channel name as a parameter. MicroIRC will
  84. automatically fill in the channel name of the current window if you
  85. don't specify a channel name on your own.
  86.  
  87. For commands which require a nick name (e.g. /MSG or /OP, there
  88. are three special shortcut arguments:
  89.  
  90. .
  91.      The period is replaced with the nickname of the last person you
  92.      have send a private message to.
  93.  
  94. ,
  95.      The comma is replaced with the nickname of the last person who
  96.      send a message to you. Be careful with this, since you might
  97.      easily address the wrong person if someone sends you a message
  98.      while you are still typing this command!
  99.  
  100. :
  101.      The colon is replaced with the nickname of the last person which
  102.      you haved a addressed with a nick: prefix inside a channel.
  103.  
  104. Reference
  105. =========
  106.  
  107. JOIN
  108. ----
  109.  
  110. Usage: /JOIN channel[,channel[,...]] [key[,key[,...]]]
  111. Usage: /CHANNEL channel[,channel[,...]] [key[,key[,...]]]
  112.  
  113. DESCRIPTION:
  114.  
  115. Join a channel on the IRC.  If the channel doesn't exists, it is
  116. automatically created.
  117.  
  118. There are two kinds of channels:  Channel names starting with an
  119. # are global channels and available on all IRC servers which
  120. are connected to the net you are currently on.  Channels which begin
  121. with & are local to the chat server you are connected to.
  122.  
  123. If a channel requires a special keyword to join, you must submit this
  124. after the channel name.
  125.  
  126. MicroIRC will look for a channel window which isn't currently bound to
  127. a channel. If it doesn't find one, a new window will be created and
  128. bound to this channel.
  129.  
  130. EXAMPLES:
  131.  
  132. /JOIN #Amigager
  133.      Join channel #AmigaGER
  134.  
  135. /JOIN #Amigager,#Amiga
  136.      Join channels #AmigaGER and #Amiga
  137.  
  138. /JOIN #Amigawarez coolstuff
  139.      Join channel #Amigawarez with keyword coolstuff.
  140.  
  141. RELATED TOPICS:
  142.  
  143. See LEAVE.
  144.  
  145. LEAVE
  146. -----
  147.  
  148. Usage: /LEAVE [channel[,channel[,...]]
  149.  
  150. DESCRIPTION:
  151.  
  152. Leaves a channel. If you don't give a channel name as a parameter, the
  153. channel currently bound to the window in which in the command is
  154. entered will be left.
  155.  
  156. EXAMPLES:
  157.  
  158. /LEAVE
  159.      Leave the channel currently bound to this window.
  160.  
  161. /LEAVE #Amigawarez
  162.      Leave channel #Amigawarez.
  163.  
  164. RELATED TOPICS:
  165.  
  166. See JOIN.
  167.  
  168. RAW
  169. ---
  170.  
  171. Usage: /RAW text
  172.  
  173. DESCRIPTION:
  174.  
  175. Sends text directly to the IRC server without any further processing.
  176. Warning: Don't even think about using this command without interior
  177. knowledge of the IRC protocol, or you might run into severe trouble.
  178. See `RFC 1459' for a description of the IRC protocol.
  179.  
  180. EXAMPLES:
  181.  
  182. /RAW JOIN #IRC-Heros
  183.      Send the string JOIN #IRC-Heros directly to the IRC server.
  184.  
  185. RELATED TOPICS:
  186.  
  187. `RFC 1459'.
  188.  
  189. Customizing your environment
  190. ****************************
  191.  
  192. Overview
  193. ========
  194.  
  195. Yet to write
  196.  
  197. CTCP commands
  198. *************
  199.  
  200. Overview
  201. ========
  202.  
  203. Yet to write
  204.  
  205. MicroIRC's ARexx Port
  206. *********************
  207.  
  208. Overview
  209. ========
  210.  
  211. MicroIRC supports a versatile ARexx Port.
  212.  
  213. Reference
  214. =========
  215.  
  216. SAY
  217. ---
  218.  
  219. Usage: SAY TEXT/F
  220.  
  221. DESCRIPTION:
  222.  
  223. Treats TEXT just like it has been entered in the string gadget of the
  224. current window.
  225.  
  226. EXAMPLES:
  227.  
  228.     say '/JOIN #Amigager'
  229.  
  230. RELATED TOPICS:
  231.  
  232. ISCONNECTED
  233. -----------
  234.  
  235. Usage: ISCONNECTED
  236.  
  237. DESCRIPTION:
  238.  
  239. Checks whether a connection is currently established. Returns RC 0 if
  240. the link is up, RC 5 otherwise.
  241.  
  242. EXAMPLES:
  243.  
  244.     ISCONNECTED; say rc
  245.  
  246. RELATED TOPICS:
  247.  
  248. GETMYNICK
  249. ---------
  250.  
  251. Usage: GETMYNICK
  252.  
  253. DESCRIPTION:
  254.  
  255. Returns your current nickname.
  256.  
  257. EXAMPLES:
  258.  
  259.     GETMYNICK; say result
  260.  
  261. RELATED TOPICS: See RX_GETSERVERNAME.
  262.  
  263. GETSERVERNAME
  264. -------------
  265.  
  266. Usage: GETSERVERNAME
  267.  
  268. DESCRIPTION:
  269.  
  270. Returns the name of the IRC server you are currently connected to.
  271.  
  272. EXAMPLES:
  273.  
  274.     GETSERVERNAME; say result
  275.  
  276. RELATED TOPICS: See RX_GETMYNICK.
  277.  
  278. USERHOST
  279. --------
  280.  
  281. Usage: USERHOST NICK/A
  282.  
  283. DESCRIPTION:
  284.  
  285. Returns the userhost specification belonging to NICK.
  286. AMIRC keeps a internal list of the userhosts of every nick that occured
  287. yet. You can query this database with this command.  Note however that
  288. it is possible that the userhost isn't in the database yet; this
  289. command will not query the server than, but simply return an error.
  290.  
  291. EXAMPLES:
  292.  
  293.     USERHOST Olli; say result
  294.  
  295. RELATED TOPICS: See RX_GETMYNICK.
  296.  
  297. NYI
  298. ***
  299.  
  300. Overview
  301. ========
  302.  
  303. Yet to write
  304.  
  305. Index
  306. *****
  307.  
  308.  
  309.